Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improvements to main README file and reference documentation #121

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Improvements to main README file and reference documentation #121

wants to merge 2 commits into from

Conversation

rsbrooks
Copy link

Made the following updates to the main README file (docs/intro.rst) to improve readability and add missing information:

  • Changed 'Introduction' section header to 'What is wcwidth?'.
  • Reformatted 'Introduction' section and fixed minor grammatical issues.
  • Added 'Getting Started' section.
  • 'Getting Started' section includes basic API function information, links to PyPI package, links to API documentation site, Unicode environment variable config, and pip install instructions
  • Added 'Helpful Resources for Contributors' section.
  • 'Helpful Resources for Contributors' section includes instructions for making local changes to source code, updating Unicode data tables, building documentation, executing unit tests, updating requirements, and using supplemental utilities.

@rsbrooks
Rewrote and reformatted the 'Introduction' section to improve readabi…
fa5bba3 
…lity. Updated 'Introduction' section header to 'What is wcwidth?'.
@rsbrooks
Added 'Getting Started' and 'Helpful Resources for Contributors' sect…
eec69c6 
…ions to main README (docs/intro.rst). Rearranged content from existing sections, reformatted information, fixed minor grammatical errors, added missing links and info, and rewrote various segments to improve readability.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@rsbrooks